home *** CD-ROM | disk | FTP | other *** search
/ InterCD 2000 September / september_2000.iso / intercd / root / ^Linux / cfengine-1.5.3 / contrib / cfdoc.in next >
Encoding:
Text File  |  1997-04-10  |  4.2 KB  |  142 lines
  1. #! @PERL@
  2. # -*- Perl -*-
  3. #
  4. # Copyright (C) 1995 Andrew Ford
  5. #
  6. #    This program is free software; you can redistribute it and/or modify
  7. #    it under the terms of the GNU General Public License as published by
  8. #    the Free Software Foundation; either version 2 of the License, or
  9. #    (at your option) any later version.
  10. #
  11. #    This program is distributed in the hope that it will be useful,
  12. #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. #    GNU General Public License for more details.
  15. #
  16. # cfdoc -- Simple utility to document a cfengine configuration file 
  17. #          (or other configuration file that uses '#' in the first 
  18. #          line to indicate comments).
  19. #
  20. # Author:
  21. #   Andrew Ford                     Email:  andrew@icarus.demon.co.uk
  22. #   Independent Software Consultant WWW:    http://www.nhbs.co.uk/aford/aford.html
  23. #   "Brittany", Wells Road,         Tel:    +44 1452 770836  Fax: 770835
  24. #   Eastcombe, Stroud, GL6 7EE, GB  Mobile: +44 385 258278
  25. #
  26. # Comments starting in column 0 are regarded as text to be typeset (this
  27. # can contain arbitrary markup), while other lines are regarded as code 
  28. # to be set in a verbatim environment.  The default comment indicator is
  29. # '#' and verbatim environments are enclosed in \begin{verbatim} and
  30. # \end{verbatim} pairs, but this behaviour can be overridden with command
  31. # line options.
  32. # 
  33.  
  34. &parse_cmd_line;
  35. &format_file;
  36.  
  37. # Format a file
  38.  
  39. sub format_file {
  40.     while (<>) {
  41.  
  42.     # Start state - look for "#!/" on first line and ignore if found.
  43.     
  44.     next if /^\#!(.*)/ && !$state++;
  45.     
  46.     chop if /\n$/;
  47.     
  48.     # Lines that start with a '#' in the first column are printed
  49.     # without the '#'
  50.     # If the previous line was not part of a comment then the
  51.     # currently open verbatim environment is closed.
  52.     
  53.     if (/^$comment_marker\s*(.*)/) {
  54.         if ($in_code) {
  55.         print($end_verbatim);
  56.         $in_code = 0;
  57.         }
  58.         print("$1\n");
  59.         $blank_lines = 0;
  60.  
  61.     } 
  62.     
  63.     # Other lines are printed in a verbatim environment (which
  64.     # is opened if not already open).
  65.     # Blank lines are counted and only output if they apear within
  66.     # a block of code.
  67.  
  68.     else {
  69.         $blank_lines++, next if /^\s*$/;    
  70.         if (!$in_code) {
  71.         print($start_verbatim);
  72.         $in_code = 1;
  73.         } elsif ($blank_lines) {
  74.         foreach $i (1 .. $blank_lines) {
  75.             print("\n");
  76.         }
  77.         $blank_lines = 0;
  78.         }
  79.         print("$_\n");
  80.     }
  81.     }
  82.  
  83.     print $end_verbatim if $in_code;
  84. }
  85.  
  86.  
  87. # Parse the command line
  88.  
  89. sub parse_cmd_line {
  90.  
  91.     $comment_marker         = "#";
  92.     $latex_start_verbatim   = "\\begin{verbatim}\n";
  93.     $latex_end_verbatim     = "\\end{verbatim}\n";
  94.     $html_start_verbatim    = "<PRE>\n";
  95.     $html_end_verbatim      = "</PRE>\n";
  96.     $texinfo_start_verbatim = "\@smallexample\n";
  97.     $texinfo_end_verbatim   = "\@end smallexample\n";
  98.  
  99.     $start_verbatim = $latex_start_verbatim;
  100.     $end_verbatim   = $latex_end_verbatim;
  101.  
  102.     $usage = "usage: $0 [options] <file\n" .
  103.           "    -c comment_marker     string indicating comment line (default is '#')\n" .
  104.          "    -l language           markup language to use (default is LaTeX)\n" .
  105.          "    -s start-marker       markup for start of code (default \\begin{verbatim})\n" .
  106.          "    -e end-marker         markup for end of code (default \\end{verbatim})\n" .
  107.          "Known languages are \"LaTeX\" (default), \"HTML\" and \"texinfo\".\n";
  108.  
  109.     require "getopts.pl";
  110.     &Getopts('c:l:s:e:') || die $usage;
  111.  
  112.     if (defined($opt_c)) {
  113.     $comment_marker = $opt_c;
  114.     }
  115.  
  116.     if (defined($opt_l)) {
  117.     if ($opt_l eq "latex" || $opt_l eq "LaTeX") {
  118.         $start_verbatim = $latex_start_verbatim;
  119.         $end_verbatim   = $latex_end_verbatim;
  120.     } elsif ($opt_l eq "html" || $opt_l eq "HTML") {
  121.         $start_verbatim = $html_start_verbatim;
  122.         $end_verbatim   = $html_end_verbatim;
  123.     } elsif ($opt_l eq "texinfo" || $opt_l eq "TEXINFO") {    
  124.         $start_verbatim = $texinfo_start_verbatim;
  125.         $end_verbatim   = $texinfo_end_verbatim;
  126.     } else {
  127.         die "Unknown markup language: \"$opt_l\".\n" . $usage;
  128.     }
  129.     }
  130.     if (defined($opt_s)) {
  131.     $start_verbatim = $opt_s;
  132.     }
  133.     if (defined($opt_e)) {
  134.     $end_verbatim = $opt_e;
  135.     }
  136. }
  137.  
  138.  
  139.  
  140.  
  141.  
  142.